pdfshift adaptor documentation #698
Conversation
Signed-off-by: Hunter Achieng <[email protected]>
There was a problem hiding this comment.
The hardest bit of this, I think, is understanding how to use the PDF once it's been generated. What do you do with it?
I'm not sure you can pass it downstream to another step? Have we tried this? Because it may not serialise well, and that may cause problems either in the dataclip or in downstream state. And if so, that's stuff needs documenting.
Signed-off-by: Hunter Achieng <[email protected]>
Signed-off-by: Hunter Achieng <[email protected]>
Signed-off-by: Hunter Achieng <[email protected]>
|
@hunterachieng before we can merge this I think we need to look at OpenFn/adaptors#1338 And these docs are surfacing a couple of behavioural things that I'm worried about, like this JSON.parse step I think we need to patch the adaptor before we release these docs |
|
@josephjclark Since the |
|
The option being What I really mean is: if PDF shift returns us a JSON response, we should automatically parse that and return it to state.data. That should be magic within the adaptor, not an intervention in job code |
|
Understood. Let me work on that ASAP. |
Signed-off-by: Hunter Achieng <[email protected]>
Short Description
Add
pdfShiftdocumentation with examples.Closes #679
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy